package site.huoqiang.emos.config;

import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
import io.swagger.v3.oas.annotations.info.Info;
import io.swagger.v3.oas.annotations.security.SecurityScheme;
import org.springframework.context.annotation.Configuration;

/**
 * @author: huoqiang huoqiang
 * @date: 2022-01-12
 *
 * 其中 @SecurityScheme 注解定义的是JWT部分,也就是说，一会儿我们在Swagger页面上可以看到Authorize按钮，
 * 我们可以设置HTTP请求头上传的JWT令牌。当然了，其中请求头的名字叫做token（本项目用Sa-Token权限与认证框架，
 * 该框架要求请求头用token保存令牌），如果你后端的JWT要求的请求头名字不叫做这个，你可以在上面的注解中修改name属性。
 */
@Configuration
@OpenAPIDefinition(
        info = @Info(
                title = "emos-api",
                description = "Emos管理系统后端Java项目",
                version = "1.0"
        )
)

@SecurityScheme(
        name = "token",
        type = SecuritySchemeType.HTTP,
        bearerFormat = "JWT",
        scheme = "bearer"
)
public class SpringDocConfig {
}
